Fzzy Config/me.fzzyhmstrs.fzzy_config.screen.widget/LayoutClickableWidget

LayoutClickableWidget

class LayoutClickableWidget(x: Int, y: Int, width: Int, height: Int, layout: LayoutWidget) : ClickableWidget, ParentElement, TooltipChild

Clickable widget that contains a LayoutWidget which provides and lays out children of this widget. The layout will be automatically constrained to the dimensions of the widget, and updated as the position and size changes.

Author

fzzyhmstrs

Since

0.6.0

Parameters

X position of the widget in pixels

Y position of the widget in pixels

width

width of the widget in pixels

height

height of the widget in pixels

layout

LayoutWidget the layout wrapped by this widget

Constructors

LayoutClickableWidget

constructor(x: Int, y: Int, width: Int, height: Int, layout: LayoutWidget)

Properties

active

var active: Boolean

message

var message: Text

navigationOrder

var navigationOrder: Int

visible

var visible: Boolean

val x: Int

val y: Int

Functions

appendNarrations

override fun appendNarrations(builder: NarrationMessageBuilder)

charTyped

open override fun charTyped(chr: Char, modifiers: Int): Boolean

children

open override fun children(): MutableList<out Element>

forEachChild

open override fun forEachChild(consumer: Consumer<ClickableWidget>)

getBottom

open fun getBottom(): Int

getFocused

open override fun getFocused(): Element?

getFocusedPath

open override fun getFocusedPath(): GuiNavigationPath?

getHeight

open override fun getHeight(): Int

getNavigationFocus

open override fun getNavigationFocus(): ScreenRect

getNavigationPath

open override fun getNavigationPath(navigation: GuiNavigation?): GuiNavigationPath?

getRight

open fun getRight(): Int

getTooltip

@Nullable

open fun getTooltip(): Tooltip?

getType

open override fun getType(): Selectable.SelectionType

getWidth

open override fun getWidth(): Int

hoveredElement

open fun hoveredElement(mouseX: Double, mouseY: Double): Optional<Element>

isDragging

open override fun isDragging(): Boolean

isFocused

open override fun isFocused(): Boolean

isHovered

open fun isHovered(): Boolean

isMouseOver

open override fun isMouseOver(mouseX: Double, mouseY: Double): Boolean

isNarratable

open override fun isNarratable(): Boolean

isSelected

open fun isSelected(): Boolean

keyPressed

open override fun keyPressed(keyCode: Int, scanCode: Int, modifiers: Int): Boolean

keyReleased

open override fun keyReleased(keyCode: Int, scanCode: Int, modifiers: Int): Boolean

mouseClicked

open override fun mouseClicked(mouseX: Double, mouseY: Double, button: Int): Boolean

mouseDragged

open override fun mouseDragged(mouseX: Double, mouseY: Double, button: Int, deltaX: Double, deltaY: Double): Boolean

mouseMoved

open fun mouseMoved(mouseX: Double, mouseY: Double)

mouseReleased

open override fun mouseReleased(mouseX: Double, mouseY: Double, button: Int): Boolean

mouseScrolled

open override fun mouseScrolled(mouseX: Double, mouseY: Double, horizontalAmount: Double, verticalAmount: Double): Boolean

onClick

open override fun onClick(mouseX: Double, mouseY: Double)

onRelease

open fun onRelease(mouseX: Double, mouseY: Double)

playDownSound

open fun playDownSound(soundManager: SoundManager)

provideNarrationLines

open fun provideNarrationLines(): List<Text>

Provides a list of text for appending into a Narration Hint. By default this will use the same lines passed from provideTooltipLines, with predefined values for the inputs

provideTooltipLines

open fun provideTooltipLines(mouseX: Int, mouseY: Int, parentSelected: Boolean, keyboardFocused: Boolean): List<Text>

Provides a list of text lines for appending to a tooltip. Unlike appending in MC, the parent has final say on compiling the tooltip from the pieces given to it.

render

override fun render(context: DrawContext, mouseX: Int, mouseY: Int, delta: Float)

setAlpha

open fun setAlpha(alpha: Float)

setDimensions

open override fun setDimensions(width: Int, height: Int)

setDimensionsAndPosition

open override fun setDimensionsAndPosition(width: Int, height: Int, x: Int, y: Int)

setDragging

open override fun setDragging(dragging: Boolean)

setFocused

open override fun setFocused(focused: Boolean)

open override fun setFocused(focused: Element?)

setHeight

open override fun setHeight(height: Int)

setPosition

open override fun setPosition(x: Int, y: Int)

setTooltip

open fun setTooltip(@Nullable tooltip: Tooltip?)

setTooltipDelay

open fun setTooltipDelay(tooltipDelay: Duration)

setWidth

open override fun setWidth(width: Int)

setX

open override fun setX(x: Int)

setY

open override fun setY(y: Int)

withNarrationAppender

fun withNarrationAppender(narrationAppender: Consumer<NarrationMessageBuilder>): LayoutClickableWidget

Applies custom narration to this layout widget. This consumer will be applied on every call to narration building, using the same message level as the default narration of the widget. In particular, element POSITION and USAGE information is typically applied already. The current hovered and/or focused child widget uses the next message layer. If you have to dodge one of both of these existing additions, you will have to add one or two more layers to the builder before using it.